Add Markdown diff linter #879
Merged
+104
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/hold |
ivanvc
force-pushed
the
add-markdown-diff-linter
branch
from
3864c40 to
89feba7
Compare
|
/unhold |
ivanvc
force-pushed
the
add-markdown-diff-linter
branch
2 times, most recently
from
2d222a1 to
cffd6de
Compare
Add Makefile target, and scripts to lint only the modified Markdown files, failing only if the violation is within the changed lines. Signed-off-by: Ivan Valdes <[email protected]>
ivanvc
force-pushed
the
add-markdown-diff-linter
branch
from
cffd6de to
954cf31
Compare
spzala
approved these changes
Aug 8, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ivanvc, jmhbnz, spzala The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I had this issue open for a while but couldn't get back to it.
It adds a GitHub workflow(EDIT: we decided to make this a standalone script, so it can be used with prow) that links changed Markdown files and fails if the issue is within the changed lines.It uses NodeJS' markdownlint-cli2, which has improvements over markdownlint-cli. I introduced a configuration file,
.markdownlint-cli2.yaml, which allows lines longer than 80 characters, as this rule would raise issues in every Markdown file we have in the repository.This should help with reviews, avoiding discussing Markdown formatting.
An example of a run at my fork: ivanvc#6.
Fixes #857.